API 参考指南

本 Kaspersky Security Center OpenAPI 参考指南旨在帮助完成以下任务：

• 自动化和自定义。您可以将您可能不想使用管理控制台手动处理的任务自动化。您还可以实施管理控制台尚不支持的自定义方案。例如，作为管理员，您可以使用 Kaspersky Security Center OpenAPI 创建和运行脚本，这些脚本将有助于开发管理组的结构并使该结构保持最新。
• 自定义开发。例如，您可以为客户开发一个替代的基于 MMC 的管理控制台，该控制台允许执行有限的一组操作。

在 OpenAPI 参考指南中，您可以使用屏幕右侧的搜索字段查找所需的信息。

OPENAPI 参考指南

脚本示例

OpenAPI 参考指南包含下表中列出的 Python 脚本示例。这些示例展示了如何调用 OpenAPI 方法并自动完成保护网络的各种任务，例如，创建“主要/从属”层级，在 Kaspersky Security Center 中运行任务，或分配分发点。您可以按原样运行示例，也可以基于示例创建您自己的脚本。

要调用 OpenAPI 方法并运行脚本：

1. 下载 KlAkOAPI.tar.gz 压缩文件。此压缩文件包括 KlAkOAPI 软件包和示例（您可以从压缩文件或 OpenAPI 参考指南中复制它们）。KlAkOAPI.tar.gz 存档也位于 Kaspersky Security Center 安装文件夹中。
2. 在安装了管理服务器的设备上安装来自 KlAkOAPI.tar.gz 压缩文件的 KlAkOAPI 软件包。

   您只能在安装了管理服务器和 KlAkOAPI 软件包的设备上调用 OpenAPI 方法、运行示例和您自己的脚本。

   用户方案与 Kaspersky Security Center OpenAPI 方法示例之间的匹配

   示例	示例目的	方案
   Log KlAkParams	您可以使用 KlAkParams 数据结构提取和处理数据。该示例展示了如何使用此数据结构。 该示例输出可以以不同的方式呈现。您可以获取数据以发送 HTTP 方法或在您的代码中使用它。	监控和报告
   创建和删除“主要/从属”层次结构	您可以添加从属管理服务器，并建立“主要/从属”层次结构。或者，您可以断开从属管理服务器与层次结构的连接。	创建管理服务器层级：添加从属管理服务器 删除管理服务器层级
   使用基于 Active Directory 单元的结构创建组层次结构	您可以轮询 Active Directory 单元并形成已发现设备组的层次结构。	创建管理组
   使用基于缓存的 Active Directory 单元的结构创建组层次结构	您可以根据之前轮询的 Active Directory 单元形成受管理设备组的层次结构。如果新设备在上次轮询后出现在 Active Directory 中，则不会将它们添加到组中，因为它们不在保存的轮询结果中。	创建管理组
   通过连接网关下载网络列表文件到指定设备	您可以通过使用连接网关连接到所需设备上的网络代理，然后将包含网络列表的文件下载到您的设备。	分发点和连接网关的调整
   将主管理服务器存储库中存储的授权许可密钥安装到从属管理服务器上	您可以连接到主管理服务器，从中下载所需的授权许可密钥，然后将此密钥传输到层次结构中包含的所有从属管理服务器。	受管理应用程序的授权许可
   创建有效用户权限报告	您可以创建不同的报告。例如，您可以使用此示例生成有效用户权限的报告。此报告描述了用户拥有的权限，具体取决于他或她的组和角色。 您可以下载 HTML、PDF 或 Excel 格式的报告。	生成和浏览报告
   为设备启动任务	您可以通过使用连接网关连接到所需设备上的网络代理，然后允许必要的任务。	手动启动任务
   基于 Active Directory 站点和服务创建 IP 子网	您可以根据您使用的 Active Directory 单元创建 IP 子网。 该示例启动对指定 IP 范围的轮询并删除发现的子网，以避免它们与新子网发生冲突。因此，请勿在需要保存子网的网络中运行此示例。 轮询后，示例引用 Active Directory，检查其中的每个设备，并创建 IP 子网。为此，示例使用了所有设备的掩码和 IP 地址。	配置网络保护
   为组中的设备注册分发点	您可以将受管理设备分配为分发点（以前称为更新代理）。	更新 Kaspersky 数据库和应用程序
   对所有组进行枚举	您可以对管理组采取不同操作。该示例显示了如何执行以下操作： 获取“受管理设备”根组的标识符 在组层次结构中移动 检索完整的、扩展的组层次结构以及它们的名称和嵌套	配置管理服务器
   枚举任务、查询任务统计信息和运行任务	您可以找到以下信息： 任务进度历史 当前任务状态 不同状态的任务数 您还可以运行任务。默认情况下，示例在输出统计信息后运行任务。	监视任务执行
   创建并运行任务	您可以创建任务。在示例中指定以下任务参数： 类型 运行方法 名称 将使用任务的设备组 默认情况下，示例创建了一个“显示消息”类型的任务。您可以为管理服务器的所有受管理设备运行此任务。如有需要，您可以指定自己的任务参数。	创建任务
   枚举授权许可密钥	您可以获得安装在管理服务器受管理设备上的 Kaspersky 应用程序的所有活动授权许可密钥的列表。该列表包含关于每个授权许可密钥的详细数据，例如名称、类型或到期日期。	查看使用中授权许可密钥的相关信息
   创建和查找内部用户	您可以创建一个账户以进行进一步的工作。	选择账户以启动管理服务器
   创建自定义类别	您可以根据所需参数创建应用程序类别。	创建含有手动添加内容的应用程序类别
   使用 SrvView 枚举用户	您可以使用 SrvView 类向管理服务器请求详细信息。例如，您可以使用此示例获取用户列表。	管理用户账户

通过 OpenAPI 与 Kaspersky Security Center 交互的应用程序

一些应用程序通过 OpenAPI 与 Kaspersky Security Center 交互。例如，此类应用程序包括 Kaspersky Anti Targeted Attack Platform 或 Kaspersky Security for Virtualization。这也可以是您基于 OpenAPI 开发的自定义客户端应用程序。

通过 OpenAPI 与 Kaspersky Security Center 交互的应用程序连接到管理服务器。如果您配置了可连接到管理服务器的 IP 地址允许列表，请添加安装了使用 Kaspersky Security Center OpenAPI 的应用程序的设备的 IP 地址。要了解您使用的应用程序是否通过 OpenAPI 工作，请参阅此应用程序的帮助。

页顶